Page Customization
Last updated: July 22, 2025
Page Customization
FoxWiki allows you to customize individual pages using YAML frontmatter. Frontmatter is metadata that you can add to the top of your markdown files to control how pages are displayed and behave.
What is YAML Frontmatter?
YAML frontmatter is a block of YAML code that appears at the very beginning of a markdown file, enclosed between triple dashes (
---
). It allows you to set metadata and configuration options for individual pages.Basic Structure
Available YAML Properties
FoxWiki currently supports the following YAML frontmatter properties:
title
- Type: String
- Required: No
- Description: Sets the display title for the page
- Fallback: If not provided, FoxWiki will use the first H1 heading (# Heading) in the content, or the filename if no H1 heading is found
Example:
icon
- Type: String
- Required: No
- Description: Sets an icon that will be displayed alongside the page title in navigation and page listings
- Format: Can be an emoji, Material Design icon name, or other icon identifier
- Fallback: If not provided, FoxWiki will use the default "Text" Material Design icon
Examples:
Complete Examples
Example 1: Documentation Page
Example 2: Welcome Page